Mule : Ssl Provider
This page last changed on Aug 20, 2006 by aperepel.
The Ssl connector can be used for secure socket communication using ssl or tls.
The javadoc for this transport provider can be found here. And the Source Xref can be found here
SSL Connector Properties
 |
See Tcp Provider for extra properties inherited by this connector. |
| Property | Description | Default | Required |
|---|---|---|---|
| timeout | The socket read timeout | 5000 | Yes |
| bufferSize | The buffer size used to read and write data | 64*1024 | Yes |
| keyStore | The location of the server keystore used to create a secure server socket | Yes (if connector is being used as a server) | |
| keyPassword | The password used to check integrity and unlock the key store | Yes (if keyStore is set) | |
| storePassword | The password for the server keystore | Yes (if keyStore is set) | |
| keyStoreType | The type of keystore being used | KeyStore.getDefaultType() | Yes (if keyStore is set) |
| keyManagerAlgorithm | The Key Manager algorithm to use | Depends on the JDK vendor, automatically discovered. | Yes (if keyStore is set) |
| trustManagerAlgorithm | The Trust Manager algorithm to use | The same as keyManagerAlgorithm | No |
| protocolHandler | The value used for java.protocol.handler.pkgs | Depends on the JDK vendor, automatically discovered. | Yes |
| requireClientAuthentication | Whether clients should be authenticated when connecting | true | Yes (if keyStore is set) |
| provider | The sercurity provider object to register with the java Security manager | Depends on the JDK vendor, automatically discovered. | Yes (if keyStore is set) |
| clientKeyStore | The location of the client keystore. This value is used to set javax.net.ssl.keyStore | Yes (if connector is being used by a client) | |
| clientKeyStorePassword | The password for the client keystore. This value is used to set javax.net.ssl.keyStorePassword | Yes (if clientKeyStore is set) | |
| trustStore | The location of the trust keystore. This value is used to set javax.net.ssl.trustStore | (use clientKeystore) | No |
| trustStorePassword | The password for the trustStore. This value is used to set javax.net.ssl.trustStorePassword | Yes (if trustStore is set) | |
| trustStoreType | The type of the truststore being used | KeyStore.getDefaultType() | No |
| explicitTrustStoreOnly | Whether to use the clientKeyStore details as the trustStore details if a trustStore hasn't been explicitly set | false | No |
| keyManagerFactory | The KeyManager factory to use. You woundn't normally set this as the KeyManagerFactory is determined based on the keyManagerAlgorithm | No | |
| trustManagerFactory | The TrustManager factory to use. Normally determined based on the trustManagerAlgorithm | No |
Endpoints
SSL endpoints are described as socket-based endpoints in the form of -
ssl://localhost:1234
To use TLS instead of SSL you just need to change the endpoint URI protocol -
tls://localhost:1234
Transformers
The following transformers are used by default for this connector unless a transformer is explicitly set on the provider.
| Transformer | Description |
|---|---|
| ByteArrayToString | converts a byte array to a String |
| StringToByteArray | Converts a String to a byte array |
